/**
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.guicerecipes.support;

/**
 * A handler of exceptions when closing down resources. Implementations will typically create a collection of error messages so that all of the different close exceptions are collected together.
 * 
 * @version $Revision: 1.1 $
 */
public interface CloseErrors {

	/**
	 * Notification of a close exception
	 * 
	 * @param key the key of the object being closed which is usually a {@link com.google.inject.Key} or {@link String}
	 * @param object the object being closed
	 * @param cause the exception thrown when the close was attempted
	 */
	void closeError(Object key, Object object, Exception cause);

	void throwIfNecessary() throws CloseFailedException;
}
